/**
 *    Copyright (C) 2021-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */
#pragma once

#include "mongo/db/dbdirectclient.h"
#include "mongo/db/service_context_d_test_fixture.h"

namespace mongo {

class DeprecatedServerParameterTest : public ServiceContextMongoDTest {
public:
    void testParameterIsDeprecated(StringData parameterName) {
        auto&& m = ServerParameterSet::getNodeParameterSet()->getMap();
        auto it = m.find(parameterName);
        ASSERT(it != m.end()) << "Not found: " << parameterName;
        auto&& [key, sp] = *it;
        ASSERT_EQ(key, parameterName);
        ASSERT_EQ(sp->name(), parameterName);
        ASSERT_TRUE(sp->getIsDeprecated());
    }

    template <typename ValType>
    void testSetParameterWarnsOnce(StringData parameterName, ValType value) {
        unittest::LogCaptureGuard logs;
        auto opCtx = cc().makeOperationContext();
        DBDirectClient client(opCtx.get());
        BSONObj result;
        auto cmdBSON = BSON("setParameter" << 1 << parameterName << value);
        ASSERT(client.runCommand(DatabaseName::kAdmin, cmdBSON, result));

        const auto parameterAttrBSON = BSON("attr" << BSON("parameter" << parameterName));

        // Check that the deprecation warning was logged once.
        ASSERT_EQ(logs.countBSONContainingSubset(parameterAttrBSON), 1);

        ASSERT(client.runCommand(DatabaseName::kAdmin, cmdBSON, result));

        // Check that the deprecation warning is not logged again by a repeated setParameter.
        ASSERT_EQ(logs.countBSONContainingSubset(parameterAttrBSON), 1);
    }
};

}  // namespace mongo
